<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="content_v2_1.html">Content API for Shopping</a> . <a href="content_v2_1.promotions.html">promotions</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
  <code><a href="#create">create(merchantId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Inserts a promotion for your Merchant Center account. If the promotion already exists, then it updates the promotion instead. To [end or delete] (https://developers.google.com/shopping-content/guides/promotions#end_a_promotion) a promotion update the time period of the promotion to a time that has already passed.</p>
<p class="toc_element">
  <code><a href="#get">get(merchantId, id, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves a promotion from your Merchant Center account.</p>
<p class="toc_element">
  <code><a href="#list">list(merchantId, countryCode=None, languageCode=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">List all promotions from your Merchant Center account.</p>
<p class="toc_element">
  <code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

<div class="method">
    <code class="details" id="create">create(merchantId, body=None, x__xgafv=None)</code>
  <pre>Inserts a promotion for your Merchant Center account. If the promotion already exists, then it updates the promotion instead. To [end or delete] (https://developers.google.com/shopping-content/guides/promotions#end_a_promotion) a promotion update the time period of the promotion to a time that has already passed.

Args:
  merchantId: string, Required. The ID of the account that contains the collection. (required)
  body: object, The request body.
    The object takes the form of:

{ # Represents a promotion. See the following articles for more details. * [Promotions feed specification](https://support.google.com/merchants/answer/2906014) * [Local promotions feed specification](https://support.google.com/merchants/answer/10146130) * [Promotions on Buy on Google product data specification](https://support.google.com/merchants/answer/9173673)
  &quot;brand&quot;: [ # Product filter by brand for the promotion.
    &quot;A String&quot;,
  ],
  &quot;brandExclusion&quot;: [ # Product filter by brand exclusion for the promotion.
    &quot;A String&quot;,
  ],
  &quot;contentLanguage&quot;: &quot;A String&quot;, # Required. The content language used as part of the unique identifier. `en` content language is available for all target countries. `fr` content language is available for `CA` and `FR` target countries. `de` content language is available for `DE` target country. `nl` content language is available for `NL` target country. `it` content language is available for `IT` target country. `pt` content language is available for `BR` target country. `ja` content language is available for `JP` target country. `ko` content language is available for `KR` target country.
  &quot;couponValueType&quot;: &quot;A String&quot;, # Required. Coupon value type for the promotion.
  &quot;customRedemptionRestriction&quot;: &quot;A String&quot;, # The custom redemption restriction for the promotion. If the `redemption_restriction` field is set to `CUSTOM`, this field must be set.
  &quot;freeGiftDescription&quot;: &quot;A String&quot;, # Free gift description for the promotion.
  &quot;freeGiftItemId&quot;: &quot;A String&quot;, # Free gift item ID for the promotion.
  &quot;freeGiftValue&quot;: { # The price represented as a number and currency. # Free gift value for the promotion.
    &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
    &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
  },
  &quot;genericRedemptionCode&quot;: &quot;A String&quot;, # Generic redemption code for the promotion. To be used with the `offerType` field.
  &quot;getThisQuantityDiscounted&quot;: 42, # The number of items discounted in the promotion.
  &quot;id&quot;: &quot;A String&quot;, # Output only. The REST promotion ID to uniquely identify the promotion. Content API methods that operate on promotions take this as their `promotionId` parameter. The REST ID for a promotion is of the form channel:contentLanguage:targetCountry:promotionId The `channel` field has a value of `&quot;online&quot;`, `&quot;in_store&quot;`, or `&quot;online_in_store&quot;`.
  &quot;itemGroupId&quot;: [ # Product filter by item group ID for the promotion.
    &quot;A String&quot;,
  ],
  &quot;itemGroupIdExclusion&quot;: [ # Product filter by item group ID exclusion for the promotion.
    &quot;A String&quot;,
  ],
  &quot;itemId&quot;: [ # Product filter by item ID for the promotion.
    &quot;A String&quot;,
  ],
  &quot;itemIdExclusion&quot;: [ # Product filter by item ID exclusion for the promotion.
    &quot;A String&quot;,
  ],
  &quot;limitQuantity&quot;: 42, # Maximum purchase quantity for the promotion.
  &quot;limitValue&quot;: { # The price represented as a number and currency. # Maximum purchase value for the promotion.
    &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
    &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
  },
  &quot;longTitle&quot;: &quot;A String&quot;, # Required. Long title for the promotion.
  &quot;maxDiscountAmount&quot;: { # The price represented as a number and currency. # The maximum monetary discount a customer can receive for the promotion. This field is only supported with the `Percent off` coupon value type.
    &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
    &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
  },
  &quot;minimumPurchaseAmount&quot;: { # The price represented as a number and currency. # Minimum purchase amount for the promotion.
    &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
    &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
  },
  &quot;minimumPurchaseQuantity&quot;: 42, # Minimum purchase quantity for the promotion.
  &quot;moneyBudget&quot;: { # The price represented as a number and currency. # Cost cap for the promotion.
    &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
    &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
  },
  &quot;moneyOffAmount&quot;: { # The price represented as a number and currency. # The money off amount offered in the promotion.
    &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
    &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
  },
  &quot;offerType&quot;: &quot;A String&quot;, # Required. Type of the promotion.
  &quot;orderLimit&quot;: 42, # Order limit for the promotion.
  &quot;percentOff&quot;: 42, # The percentage discount offered in the promotion.
  &quot;productApplicability&quot;: &quot;A String&quot;, # Required. Applicability of the promotion to either all products or only specific products.
  &quot;productType&quot;: [ # Product filter by product type for the promotion.
    &quot;A String&quot;,
  ],
  &quot;productTypeExclusion&quot;: [ # Product filter by product type exclusion for the promotion.
    &quot;A String&quot;,
  ],
  &quot;promotionDestinationIds&quot;: [ # Destination ID for the promotion.
    &quot;A String&quot;,
  ],
  &quot;promotionDisplayDates&quot;: &quot;A String&quot;, # String representation of the promotion display dates. Deprecated. Use `promotion_display_time_period` instead.
  &quot;promotionDisplayTimePeriod&quot;: { # A message that represents a time period. # `TimePeriod` representation of the promotion&#x27;s display dates.
    &quot;endTime&quot;: &quot;A String&quot;, # The ending timestamp.
    &quot;startTime&quot;: &quot;A String&quot;, # The starting timestamp.
  },
  &quot;promotionEffectiveDates&quot;: &quot;A String&quot;, # String representation of the promotion effective dates. Deprecated. Use `promotion_effective_time_period` instead.
  &quot;promotionEffectiveTimePeriod&quot;: { # A message that represents a time period. # Required. `TimePeriod` representation of the promotion&#x27;s effective dates.
    &quot;endTime&quot;: &quot;A String&quot;, # The ending timestamp.
    &quot;startTime&quot;: &quot;A String&quot;, # The starting timestamp.
  },
  &quot;promotionId&quot;: &quot;A String&quot;, # Required. The user provided promotion ID to uniquely identify the promotion.
  &quot;promotionStatus&quot;: { # The status of the promotion. # Output only. The current status of the promotion.
    &quot;creationDate&quot;: &quot;A String&quot;, # Date on which the promotion has been created in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format: Date, time, and offset, for example &quot;2020-01-02T09:00:00+01:00&quot; or &quot;2020-01-02T09:00:00Z&quot;
    &quot;destinationStatuses&quot;: [ # The intended destinations for the promotion.
      { # The destination status of the promotion.
        &quot;destination&quot;: &quot;A String&quot;, # The name of the destination.
        &quot;status&quot;: &quot;A String&quot;, # The status for the specified destination.
      },
    ],
    &quot;lastUpdateDate&quot;: &quot;A String&quot;, # Date on which the promotion status has been last updated in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format: Date, time, and offset, for example &quot;2020-01-02T09:00:00+01:00&quot; or &quot;2020-01-02T09:00:00Z&quot;
    &quot;promotionIssue&quot;: [ # A list of issues associated with the promotion.
      { # The issue associated with the promotion.
        &quot;code&quot;: &quot;A String&quot;, # Code of the issue.
        &quot;detail&quot;: &quot;A String&quot;, # Explanation of the issue.
      },
    ],
  },
  &quot;promotionUrl&quot;: &quot;A String&quot;, # URL to the page on the merchant&#x27;s site where the promotion shows. Local Inventory ads promotions throw an error if no promo url is included. URL is used to confirm that the promotion is valid and can be redeemed.
  &quot;redemptionChannel&quot;: [ # Required. Redemption channel for the promotion. At least one channel is required.
    &quot;A String&quot;,
  ],
  &quot;redemptionRestriction&quot;: &quot;A String&quot;, # The redemption restriction for the promotion.
  &quot;shippingServiceNames&quot;: [ # Shipping service names for the promotion.
    &quot;A String&quot;,
  ],
  &quot;storeApplicability&quot;: &quot;A String&quot;, # Whether the promotion applies to all stores, or only specified stores. Local Inventory ads promotions throw an error if no store applicability is included. An INVALID_ARGUMENT error is thrown if store_applicability is set to ALL_STORES and store_code or score_code_exclusion is set to a value.
  &quot;storeCode&quot;: [ # Store codes to include for the promotion.
    &quot;A String&quot;,
  ],
  &quot;storeCodeExclusion&quot;: [ # Store codes to exclude for the promotion.
    &quot;A String&quot;,
  ],
  &quot;targetCountry&quot;: &quot;A String&quot;, # Required. The target country used as part of the unique identifier. Can be `AU`, `CA`, `DE`, `FR`, `GB`, `IN`, `US`, `BR`, `ES`, `NL`, `JP`, `IT` or `KR`.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents a promotion. See the following articles for more details. * [Promotions feed specification](https://support.google.com/merchants/answer/2906014) * [Local promotions feed specification](https://support.google.com/merchants/answer/10146130) * [Promotions on Buy on Google product data specification](https://support.google.com/merchants/answer/9173673)
  &quot;brand&quot;: [ # Product filter by brand for the promotion.
    &quot;A String&quot;,
  ],
  &quot;brandExclusion&quot;: [ # Product filter by brand exclusion for the promotion.
    &quot;A String&quot;,
  ],
  &quot;contentLanguage&quot;: &quot;A String&quot;, # Required. The content language used as part of the unique identifier. `en` content language is available for all target countries. `fr` content language is available for `CA` and `FR` target countries. `de` content language is available for `DE` target country. `nl` content language is available for `NL` target country. `it` content language is available for `IT` target country. `pt` content language is available for `BR` target country. `ja` content language is available for `JP` target country. `ko` content language is available for `KR` target country.
  &quot;couponValueType&quot;: &quot;A String&quot;, # Required. Coupon value type for the promotion.
  &quot;customRedemptionRestriction&quot;: &quot;A String&quot;, # The custom redemption restriction for the promotion. If the `redemption_restriction` field is set to `CUSTOM`, this field must be set.
  &quot;freeGiftDescription&quot;: &quot;A String&quot;, # Free gift description for the promotion.
  &quot;freeGiftItemId&quot;: &quot;A String&quot;, # Free gift item ID for the promotion.
  &quot;freeGiftValue&quot;: { # The price represented as a number and currency. # Free gift value for the promotion.
    &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
    &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
  },
  &quot;genericRedemptionCode&quot;: &quot;A String&quot;, # Generic redemption code for the promotion. To be used with the `offerType` field.
  &quot;getThisQuantityDiscounted&quot;: 42, # The number of items discounted in the promotion.
  &quot;id&quot;: &quot;A String&quot;, # Output only. The REST promotion ID to uniquely identify the promotion. Content API methods that operate on promotions take this as their `promotionId` parameter. The REST ID for a promotion is of the form channel:contentLanguage:targetCountry:promotionId The `channel` field has a value of `&quot;online&quot;`, `&quot;in_store&quot;`, or `&quot;online_in_store&quot;`.
  &quot;itemGroupId&quot;: [ # Product filter by item group ID for the promotion.
    &quot;A String&quot;,
  ],
  &quot;itemGroupIdExclusion&quot;: [ # Product filter by item group ID exclusion for the promotion.
    &quot;A String&quot;,
  ],
  &quot;itemId&quot;: [ # Product filter by item ID for the promotion.
    &quot;A String&quot;,
  ],
  &quot;itemIdExclusion&quot;: [ # Product filter by item ID exclusion for the promotion.
    &quot;A String&quot;,
  ],
  &quot;limitQuantity&quot;: 42, # Maximum purchase quantity for the promotion.
  &quot;limitValue&quot;: { # The price represented as a number and currency. # Maximum purchase value for the promotion.
    &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
    &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
  },
  &quot;longTitle&quot;: &quot;A String&quot;, # Required. Long title for the promotion.
  &quot;maxDiscountAmount&quot;: { # The price represented as a number and currency. # The maximum monetary discount a customer can receive for the promotion. This field is only supported with the `Percent off` coupon value type.
    &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
    &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
  },
  &quot;minimumPurchaseAmount&quot;: { # The price represented as a number and currency. # Minimum purchase amount for the promotion.
    &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
    &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
  },
  &quot;minimumPurchaseQuantity&quot;: 42, # Minimum purchase quantity for the promotion.
  &quot;moneyBudget&quot;: { # The price represented as a number and currency. # Cost cap for the promotion.
    &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
    &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
  },
  &quot;moneyOffAmount&quot;: { # The price represented as a number and currency. # The money off amount offered in the promotion.
    &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
    &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
  },
  &quot;offerType&quot;: &quot;A String&quot;, # Required. Type of the promotion.
  &quot;orderLimit&quot;: 42, # Order limit for the promotion.
  &quot;percentOff&quot;: 42, # The percentage discount offered in the promotion.
  &quot;productApplicability&quot;: &quot;A String&quot;, # Required. Applicability of the promotion to either all products or only specific products.
  &quot;productType&quot;: [ # Product filter by product type for the promotion.
    &quot;A String&quot;,
  ],
  &quot;productTypeExclusion&quot;: [ # Product filter by product type exclusion for the promotion.
    &quot;A String&quot;,
  ],
  &quot;promotionDestinationIds&quot;: [ # Destination ID for the promotion.
    &quot;A String&quot;,
  ],
  &quot;promotionDisplayDates&quot;: &quot;A String&quot;, # String representation of the promotion display dates. Deprecated. Use `promotion_display_time_period` instead.
  &quot;promotionDisplayTimePeriod&quot;: { # A message that represents a time period. # `TimePeriod` representation of the promotion&#x27;s display dates.
    &quot;endTime&quot;: &quot;A String&quot;, # The ending timestamp.
    &quot;startTime&quot;: &quot;A String&quot;, # The starting timestamp.
  },
  &quot;promotionEffectiveDates&quot;: &quot;A String&quot;, # String representation of the promotion effective dates. Deprecated. Use `promotion_effective_time_period` instead.
  &quot;promotionEffectiveTimePeriod&quot;: { # A message that represents a time period. # Required. `TimePeriod` representation of the promotion&#x27;s effective dates.
    &quot;endTime&quot;: &quot;A String&quot;, # The ending timestamp.
    &quot;startTime&quot;: &quot;A String&quot;, # The starting timestamp.
  },
  &quot;promotionId&quot;: &quot;A String&quot;, # Required. The user provided promotion ID to uniquely identify the promotion.
  &quot;promotionStatus&quot;: { # The status of the promotion. # Output only. The current status of the promotion.
    &quot;creationDate&quot;: &quot;A String&quot;, # Date on which the promotion has been created in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format: Date, time, and offset, for example &quot;2020-01-02T09:00:00+01:00&quot; or &quot;2020-01-02T09:00:00Z&quot;
    &quot;destinationStatuses&quot;: [ # The intended destinations for the promotion.
      { # The destination status of the promotion.
        &quot;destination&quot;: &quot;A String&quot;, # The name of the destination.
        &quot;status&quot;: &quot;A String&quot;, # The status for the specified destination.
      },
    ],
    &quot;lastUpdateDate&quot;: &quot;A String&quot;, # Date on which the promotion status has been last updated in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format: Date, time, and offset, for example &quot;2020-01-02T09:00:00+01:00&quot; or &quot;2020-01-02T09:00:00Z&quot;
    &quot;promotionIssue&quot;: [ # A list of issues associated with the promotion.
      { # The issue associated with the promotion.
        &quot;code&quot;: &quot;A String&quot;, # Code of the issue.
        &quot;detail&quot;: &quot;A String&quot;, # Explanation of the issue.
      },
    ],
  },
  &quot;promotionUrl&quot;: &quot;A String&quot;, # URL to the page on the merchant&#x27;s site where the promotion shows. Local Inventory ads promotions throw an error if no promo url is included. URL is used to confirm that the promotion is valid and can be redeemed.
  &quot;redemptionChannel&quot;: [ # Required. Redemption channel for the promotion. At least one channel is required.
    &quot;A String&quot;,
  ],
  &quot;redemptionRestriction&quot;: &quot;A String&quot;, # The redemption restriction for the promotion.
  &quot;shippingServiceNames&quot;: [ # Shipping service names for the promotion.
    &quot;A String&quot;,
  ],
  &quot;storeApplicability&quot;: &quot;A String&quot;, # Whether the promotion applies to all stores, or only specified stores. Local Inventory ads promotions throw an error if no store applicability is included. An INVALID_ARGUMENT error is thrown if store_applicability is set to ALL_STORES and store_code or score_code_exclusion is set to a value.
  &quot;storeCode&quot;: [ # Store codes to include for the promotion.
    &quot;A String&quot;,
  ],
  &quot;storeCodeExclusion&quot;: [ # Store codes to exclude for the promotion.
    &quot;A String&quot;,
  ],
  &quot;targetCountry&quot;: &quot;A String&quot;, # Required. The target country used as part of the unique identifier. Can be `AU`, `CA`, `DE`, `FR`, `GB`, `IN`, `US`, `BR`, `ES`, `NL`, `JP`, `IT` or `KR`.
}</pre>
</div>

<div class="method">
    <code class="details" id="get">get(merchantId, id, x__xgafv=None)</code>
  <pre>Retrieves a promotion from your Merchant Center account.

Args:
  merchantId: string, Required. The ID of the account that contains the collection. (required)
  id: string, Required. REST ID of the promotion to retrieve. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents a promotion. See the following articles for more details. * [Promotions feed specification](https://support.google.com/merchants/answer/2906014) * [Local promotions feed specification](https://support.google.com/merchants/answer/10146130) * [Promotions on Buy on Google product data specification](https://support.google.com/merchants/answer/9173673)
  &quot;brand&quot;: [ # Product filter by brand for the promotion.
    &quot;A String&quot;,
  ],
  &quot;brandExclusion&quot;: [ # Product filter by brand exclusion for the promotion.
    &quot;A String&quot;,
  ],
  &quot;contentLanguage&quot;: &quot;A String&quot;, # Required. The content language used as part of the unique identifier. `en` content language is available for all target countries. `fr` content language is available for `CA` and `FR` target countries. `de` content language is available for `DE` target country. `nl` content language is available for `NL` target country. `it` content language is available for `IT` target country. `pt` content language is available for `BR` target country. `ja` content language is available for `JP` target country. `ko` content language is available for `KR` target country.
  &quot;couponValueType&quot;: &quot;A String&quot;, # Required. Coupon value type for the promotion.
  &quot;customRedemptionRestriction&quot;: &quot;A String&quot;, # The custom redemption restriction for the promotion. If the `redemption_restriction` field is set to `CUSTOM`, this field must be set.
  &quot;freeGiftDescription&quot;: &quot;A String&quot;, # Free gift description for the promotion.
  &quot;freeGiftItemId&quot;: &quot;A String&quot;, # Free gift item ID for the promotion.
  &quot;freeGiftValue&quot;: { # The price represented as a number and currency. # Free gift value for the promotion.
    &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
    &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
  },
  &quot;genericRedemptionCode&quot;: &quot;A String&quot;, # Generic redemption code for the promotion. To be used with the `offerType` field.
  &quot;getThisQuantityDiscounted&quot;: 42, # The number of items discounted in the promotion.
  &quot;id&quot;: &quot;A String&quot;, # Output only. The REST promotion ID to uniquely identify the promotion. Content API methods that operate on promotions take this as their `promotionId` parameter. The REST ID for a promotion is of the form channel:contentLanguage:targetCountry:promotionId The `channel` field has a value of `&quot;online&quot;`, `&quot;in_store&quot;`, or `&quot;online_in_store&quot;`.
  &quot;itemGroupId&quot;: [ # Product filter by item group ID for the promotion.
    &quot;A String&quot;,
  ],
  &quot;itemGroupIdExclusion&quot;: [ # Product filter by item group ID exclusion for the promotion.
    &quot;A String&quot;,
  ],
  &quot;itemId&quot;: [ # Product filter by item ID for the promotion.
    &quot;A String&quot;,
  ],
  &quot;itemIdExclusion&quot;: [ # Product filter by item ID exclusion for the promotion.
    &quot;A String&quot;,
  ],
  &quot;limitQuantity&quot;: 42, # Maximum purchase quantity for the promotion.
  &quot;limitValue&quot;: { # The price represented as a number and currency. # Maximum purchase value for the promotion.
    &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
    &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
  },
  &quot;longTitle&quot;: &quot;A String&quot;, # Required. Long title for the promotion.
  &quot;maxDiscountAmount&quot;: { # The price represented as a number and currency. # The maximum monetary discount a customer can receive for the promotion. This field is only supported with the `Percent off` coupon value type.
    &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
    &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
  },
  &quot;minimumPurchaseAmount&quot;: { # The price represented as a number and currency. # Minimum purchase amount for the promotion.
    &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
    &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
  },
  &quot;minimumPurchaseQuantity&quot;: 42, # Minimum purchase quantity for the promotion.
  &quot;moneyBudget&quot;: { # The price represented as a number and currency. # Cost cap for the promotion.
    &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
    &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
  },
  &quot;moneyOffAmount&quot;: { # The price represented as a number and currency. # The money off amount offered in the promotion.
    &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
    &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
  },
  &quot;offerType&quot;: &quot;A String&quot;, # Required. Type of the promotion.
  &quot;orderLimit&quot;: 42, # Order limit for the promotion.
  &quot;percentOff&quot;: 42, # The percentage discount offered in the promotion.
  &quot;productApplicability&quot;: &quot;A String&quot;, # Required. Applicability of the promotion to either all products or only specific products.
  &quot;productType&quot;: [ # Product filter by product type for the promotion.
    &quot;A String&quot;,
  ],
  &quot;productTypeExclusion&quot;: [ # Product filter by product type exclusion for the promotion.
    &quot;A String&quot;,
  ],
  &quot;promotionDestinationIds&quot;: [ # Destination ID for the promotion.
    &quot;A String&quot;,
  ],
  &quot;promotionDisplayDates&quot;: &quot;A String&quot;, # String representation of the promotion display dates. Deprecated. Use `promotion_display_time_period` instead.
  &quot;promotionDisplayTimePeriod&quot;: { # A message that represents a time period. # `TimePeriod` representation of the promotion&#x27;s display dates.
    &quot;endTime&quot;: &quot;A String&quot;, # The ending timestamp.
    &quot;startTime&quot;: &quot;A String&quot;, # The starting timestamp.
  },
  &quot;promotionEffectiveDates&quot;: &quot;A String&quot;, # String representation of the promotion effective dates. Deprecated. Use `promotion_effective_time_period` instead.
  &quot;promotionEffectiveTimePeriod&quot;: { # A message that represents a time period. # Required. `TimePeriod` representation of the promotion&#x27;s effective dates.
    &quot;endTime&quot;: &quot;A String&quot;, # The ending timestamp.
    &quot;startTime&quot;: &quot;A String&quot;, # The starting timestamp.
  },
  &quot;promotionId&quot;: &quot;A String&quot;, # Required. The user provided promotion ID to uniquely identify the promotion.
  &quot;promotionStatus&quot;: { # The status of the promotion. # Output only. The current status of the promotion.
    &quot;creationDate&quot;: &quot;A String&quot;, # Date on which the promotion has been created in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format: Date, time, and offset, for example &quot;2020-01-02T09:00:00+01:00&quot; or &quot;2020-01-02T09:00:00Z&quot;
    &quot;destinationStatuses&quot;: [ # The intended destinations for the promotion.
      { # The destination status of the promotion.
        &quot;destination&quot;: &quot;A String&quot;, # The name of the destination.
        &quot;status&quot;: &quot;A String&quot;, # The status for the specified destination.
      },
    ],
    &quot;lastUpdateDate&quot;: &quot;A String&quot;, # Date on which the promotion status has been last updated in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format: Date, time, and offset, for example &quot;2020-01-02T09:00:00+01:00&quot; or &quot;2020-01-02T09:00:00Z&quot;
    &quot;promotionIssue&quot;: [ # A list of issues associated with the promotion.
      { # The issue associated with the promotion.
        &quot;code&quot;: &quot;A String&quot;, # Code of the issue.
        &quot;detail&quot;: &quot;A String&quot;, # Explanation of the issue.
      },
    ],
  },
  &quot;promotionUrl&quot;: &quot;A String&quot;, # URL to the page on the merchant&#x27;s site where the promotion shows. Local Inventory ads promotions throw an error if no promo url is included. URL is used to confirm that the promotion is valid and can be redeemed.
  &quot;redemptionChannel&quot;: [ # Required. Redemption channel for the promotion. At least one channel is required.
    &quot;A String&quot;,
  ],
  &quot;redemptionRestriction&quot;: &quot;A String&quot;, # The redemption restriction for the promotion.
  &quot;shippingServiceNames&quot;: [ # Shipping service names for the promotion.
    &quot;A String&quot;,
  ],
  &quot;storeApplicability&quot;: &quot;A String&quot;, # Whether the promotion applies to all stores, or only specified stores. Local Inventory ads promotions throw an error if no store applicability is included. An INVALID_ARGUMENT error is thrown if store_applicability is set to ALL_STORES and store_code or score_code_exclusion is set to a value.
  &quot;storeCode&quot;: [ # Store codes to include for the promotion.
    &quot;A String&quot;,
  ],
  &quot;storeCodeExclusion&quot;: [ # Store codes to exclude for the promotion.
    &quot;A String&quot;,
  ],
  &quot;targetCountry&quot;: &quot;A String&quot;, # Required. The target country used as part of the unique identifier. Can be `AU`, `CA`, `DE`, `FR`, `GB`, `IN`, `US`, `BR`, `ES`, `NL`, `JP`, `IT` or `KR`.
}</pre>
</div>

<div class="method">
    <code class="details" id="list">list(merchantId, countryCode=None, languageCode=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
  <pre>List all promotions from your Merchant Center account.

Args:
  merchantId: string, Required. The ID of the account that contains the collection. (required)
  countryCode: string, [CLDR country code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) (for example, &quot;US&quot;), used as a filter on promotions target country.
  languageCode: string, The two-letter ISO 639-1 language code associated with the promotions, used as a filter.
  pageSize: integer, The maximum number of promotions to return. The service may return fewer than this value. If unspecified, at most 50 labels will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
  pageToken: string, A page token, received from a previous `ListPromotion` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListPromotion` must match the call that provided the page token.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for Promotions.List method.
  &quot;nextPageToken&quot;: &quot;A String&quot;, # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
  &quot;promotions&quot;: [ # List of all available promotions for the merchant.
    { # Represents a promotion. See the following articles for more details. * [Promotions feed specification](https://support.google.com/merchants/answer/2906014) * [Local promotions feed specification](https://support.google.com/merchants/answer/10146130) * [Promotions on Buy on Google product data specification](https://support.google.com/merchants/answer/9173673)
      &quot;brand&quot;: [ # Product filter by brand for the promotion.
        &quot;A String&quot;,
      ],
      &quot;brandExclusion&quot;: [ # Product filter by brand exclusion for the promotion.
        &quot;A String&quot;,
      ],
      &quot;contentLanguage&quot;: &quot;A String&quot;, # Required. The content language used as part of the unique identifier. `en` content language is available for all target countries. `fr` content language is available for `CA` and `FR` target countries. `de` content language is available for `DE` target country. `nl` content language is available for `NL` target country. `it` content language is available for `IT` target country. `pt` content language is available for `BR` target country. `ja` content language is available for `JP` target country. `ko` content language is available for `KR` target country.
      &quot;couponValueType&quot;: &quot;A String&quot;, # Required. Coupon value type for the promotion.
      &quot;customRedemptionRestriction&quot;: &quot;A String&quot;, # The custom redemption restriction for the promotion. If the `redemption_restriction` field is set to `CUSTOM`, this field must be set.
      &quot;freeGiftDescription&quot;: &quot;A String&quot;, # Free gift description for the promotion.
      &quot;freeGiftItemId&quot;: &quot;A String&quot;, # Free gift item ID for the promotion.
      &quot;freeGiftValue&quot;: { # The price represented as a number and currency. # Free gift value for the promotion.
        &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
        &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
      },
      &quot;genericRedemptionCode&quot;: &quot;A String&quot;, # Generic redemption code for the promotion. To be used with the `offerType` field.
      &quot;getThisQuantityDiscounted&quot;: 42, # The number of items discounted in the promotion.
      &quot;id&quot;: &quot;A String&quot;, # Output only. The REST promotion ID to uniquely identify the promotion. Content API methods that operate on promotions take this as their `promotionId` parameter. The REST ID for a promotion is of the form channel:contentLanguage:targetCountry:promotionId The `channel` field has a value of `&quot;online&quot;`, `&quot;in_store&quot;`, or `&quot;online_in_store&quot;`.
      &quot;itemGroupId&quot;: [ # Product filter by item group ID for the promotion.
        &quot;A String&quot;,
      ],
      &quot;itemGroupIdExclusion&quot;: [ # Product filter by item group ID exclusion for the promotion.
        &quot;A String&quot;,
      ],
      &quot;itemId&quot;: [ # Product filter by item ID for the promotion.
        &quot;A String&quot;,
      ],
      &quot;itemIdExclusion&quot;: [ # Product filter by item ID exclusion for the promotion.
        &quot;A String&quot;,
      ],
      &quot;limitQuantity&quot;: 42, # Maximum purchase quantity for the promotion.
      &quot;limitValue&quot;: { # The price represented as a number and currency. # Maximum purchase value for the promotion.
        &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
        &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
      },
      &quot;longTitle&quot;: &quot;A String&quot;, # Required. Long title for the promotion.
      &quot;maxDiscountAmount&quot;: { # The price represented as a number and currency. # The maximum monetary discount a customer can receive for the promotion. This field is only supported with the `Percent off` coupon value type.
        &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
        &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
      },
      &quot;minimumPurchaseAmount&quot;: { # The price represented as a number and currency. # Minimum purchase amount for the promotion.
        &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
        &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
      },
      &quot;minimumPurchaseQuantity&quot;: 42, # Minimum purchase quantity for the promotion.
      &quot;moneyBudget&quot;: { # The price represented as a number and currency. # Cost cap for the promotion.
        &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
        &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
      },
      &quot;moneyOffAmount&quot;: { # The price represented as a number and currency. # The money off amount offered in the promotion.
        &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
        &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
      },
      &quot;offerType&quot;: &quot;A String&quot;, # Required. Type of the promotion.
      &quot;orderLimit&quot;: 42, # Order limit for the promotion.
      &quot;percentOff&quot;: 42, # The percentage discount offered in the promotion.
      &quot;productApplicability&quot;: &quot;A String&quot;, # Required. Applicability of the promotion to either all products or only specific products.
      &quot;productType&quot;: [ # Product filter by product type for the promotion.
        &quot;A String&quot;,
      ],
      &quot;productTypeExclusion&quot;: [ # Product filter by product type exclusion for the promotion.
        &quot;A String&quot;,
      ],
      &quot;promotionDestinationIds&quot;: [ # Destination ID for the promotion.
        &quot;A String&quot;,
      ],
      &quot;promotionDisplayDates&quot;: &quot;A String&quot;, # String representation of the promotion display dates. Deprecated. Use `promotion_display_time_period` instead.
      &quot;promotionDisplayTimePeriod&quot;: { # A message that represents a time period. # `TimePeriod` representation of the promotion&#x27;s display dates.
        &quot;endTime&quot;: &quot;A String&quot;, # The ending timestamp.
        &quot;startTime&quot;: &quot;A String&quot;, # The starting timestamp.
      },
      &quot;promotionEffectiveDates&quot;: &quot;A String&quot;, # String representation of the promotion effective dates. Deprecated. Use `promotion_effective_time_period` instead.
      &quot;promotionEffectiveTimePeriod&quot;: { # A message that represents a time period. # Required. `TimePeriod` representation of the promotion&#x27;s effective dates.
        &quot;endTime&quot;: &quot;A String&quot;, # The ending timestamp.
        &quot;startTime&quot;: &quot;A String&quot;, # The starting timestamp.
      },
      &quot;promotionId&quot;: &quot;A String&quot;, # Required. The user provided promotion ID to uniquely identify the promotion.
      &quot;promotionStatus&quot;: { # The status of the promotion. # Output only. The current status of the promotion.
        &quot;creationDate&quot;: &quot;A String&quot;, # Date on which the promotion has been created in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format: Date, time, and offset, for example &quot;2020-01-02T09:00:00+01:00&quot; or &quot;2020-01-02T09:00:00Z&quot;
        &quot;destinationStatuses&quot;: [ # The intended destinations for the promotion.
          { # The destination status of the promotion.
            &quot;destination&quot;: &quot;A String&quot;, # The name of the destination.
            &quot;status&quot;: &quot;A String&quot;, # The status for the specified destination.
          },
        ],
        &quot;lastUpdateDate&quot;: &quot;A String&quot;, # Date on which the promotion status has been last updated in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format: Date, time, and offset, for example &quot;2020-01-02T09:00:00+01:00&quot; or &quot;2020-01-02T09:00:00Z&quot;
        &quot;promotionIssue&quot;: [ # A list of issues associated with the promotion.
          { # The issue associated with the promotion.
            &quot;code&quot;: &quot;A String&quot;, # Code of the issue.
            &quot;detail&quot;: &quot;A String&quot;, # Explanation of the issue.
          },
        ],
      },
      &quot;promotionUrl&quot;: &quot;A String&quot;, # URL to the page on the merchant&#x27;s site where the promotion shows. Local Inventory ads promotions throw an error if no promo url is included. URL is used to confirm that the promotion is valid and can be redeemed.
      &quot;redemptionChannel&quot;: [ # Required. Redemption channel for the promotion. At least one channel is required.
        &quot;A String&quot;,
      ],
      &quot;redemptionRestriction&quot;: &quot;A String&quot;, # The redemption restriction for the promotion.
      &quot;shippingServiceNames&quot;: [ # Shipping service names for the promotion.
        &quot;A String&quot;,
      ],
      &quot;storeApplicability&quot;: &quot;A String&quot;, # Whether the promotion applies to all stores, or only specified stores. Local Inventory ads promotions throw an error if no store applicability is included. An INVALID_ARGUMENT error is thrown if store_applicability is set to ALL_STORES and store_code or score_code_exclusion is set to a value.
      &quot;storeCode&quot;: [ # Store codes to include for the promotion.
        &quot;A String&quot;,
      ],
      &quot;storeCodeExclusion&quot;: [ # Store codes to exclude for the promotion.
        &quot;A String&quot;,
      ],
      &quot;targetCountry&quot;: &quot;A String&quot;, # Required. The target country used as part of the unique identifier. Can be `AU`, `CA`, `DE`, `FR`, `GB`, `IN`, `US`, `BR`, `ES`, `NL`, `JP`, `IT` or `KR`.
    },
  ],
}</pre>
</div>

<div class="method">
    <code class="details" id="list_next">list_next()</code>
  <pre>Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call &#x27;execute()&#x27; on to request the next
          page. Returns None if there are no more items in the collection.
        </pre>
</div>

</body></html>